Interface WirelessServerProcess

All Superinterfaces:
IPCObject, Process, WirelessCommon
All Known Implementing Classes:
WirelessServerProcessImpl

public interface WirelessServerProcess extends WirelessCommon
Information provided by the PKI file:

    \class WirelessServerProcess
    
    \brief WirelessServerProcess handles and manipulates wireless servers.
    
    \example network().getDevice("PC0").getProcess("WirelessServer")
    
Author:
Auto-generated
  • Method Details

    • isMacFilterEnabled

      boolean isMacFilterEnabled()
      Information provided by the PKI file:
      
          \brief Gets the mac filtering enable or disable state.
          \return Whether mac filtering is enabled or disabled. True is enabled.
          
              
      Returns:
      boolean Returns a boolean
    • setMacFilterEnabled

      void setMacFilterEnabled(boolean enable)
      Information provided by the PKI file:
      
          \brief Enables/Disables wireless mac filtering.
          \param enable Whether to enable or disable it.
          
              
      Parameters:
      enable - Takes in a parameter of enable
    • setAllowAccess

      void setAllowAccess(boolean enable)
      Information provided by the PKI file:
      
          \brief Sets the mode to allow access from listed mac addresses, or deny access for listed mac addresses
          \param enable true means allow listed mac addresses to use it. false means deny listed mac addresses.
          
              
      Parameters:
      enable - Takes in a parameter of enable
    • isAccessAllowed

      boolean isAccessAllowed()
      Information provided by the PKI file:
      
          \brief Gets the mode to allow access from listed mac addresses, or deny access for listed mac addresses
          \return If the current mode is to allow access or deny access. True mean listed macs are allowed.
          
              
      Returns:
      boolean Returns a boolean
    • removeAllMacEntries

      void removeAllMacEntries()
      Information provided by the PKI file:
      
          \brief Clears the mac filtering table
          
              
    • getAllMacEntries

      List<MACAddress> getAllMacEntries()
      Information provided by the PKI file:
      
          \brief Gets all of the mac entries
          
              
      Returns:
      List<MACAddress> Returns a List<MACAddress>
    • getMacAddressCount

      int getMacAddressCount()
      Information provided by the PKI file:
      
          \brief Gets the count of the mac addresses
          
              
      Returns:
      int Returns a int
    • getMacAddressAt

      MACAddress getMacAddressAt(int index)
      Information provided by the PKI file:
      
          \brief Gets the mac entry at index
          \param index the index of the desired mac address
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      MACAddress Returns a MACAddress
    • resetAllAssociations

      void resetAllAssociations()
      Information provided by the PKI file:
      
          \brief Resets wireless client associations so that the new filters will affect existing associations.
          
              
      Specified by:
      resetAllAssociations in interface WirelessCommon
    • addToMacFilterAddrList

      void addToMacFilterAddrList(MACAddress addr)
      Information provided by the PKI file:
      
          \brief Add a mac address to the filtering table
          \param mac String of the mac address
          \return bool whether adding was successful. Adding an existing mac will be considered successful.
          
              
      Parameters:
      addr - Takes in a parameter of addr
    • removeFromMacFilterAddrList

      void removeFromMacFilterAddrList(MACAddress addr)
      Information provided by the PKI file:
      
          \brief Removes a mac address from the filtering table
          \param mac The mac addres to remove
          
              
      Parameters:
      addr - Takes in a parameter of addr
    • isSsidBrdCastEnabled

      boolean isSsidBrdCastEnabled()
      Information provided by the PKI file:
      
          \brief Check if ssid broadcast is enabled
          \returns bool, true if ssid broadcast is enabled and false if not
          
              
      Returns:
      boolean Returns a boolean
    • setSsidBrdCastEnabled

      void setSsidBrdCastEnabled(boolean enabled)
      Information provided by the PKI file:
      
          \brief Set Ssid broadcast enabled
          \param enabled, true if ssid broadcast is enabled and false if not
          
              
      Parameters:
      enabled - Takes in a parameter of enabled